/*
 * ________________________________________________________________________________________________________
 * Copyright (c) 2015-2015 InvenSense Inc. All rights reserved.
 *
 * This software, related documentation and any modifications thereto (collectively “Software”) is subject
 * to InvenSense and its licensors' intellectual property rights under U.S. and international copyright
 * and other intellectual property rights laws.
 *
 * InvenSense and its licensors retain all intellectual property and proprietary rights in and to the Software
 * and any use, reproduction, disclosure or distribution of the Software without an express license agreement
 * from InvenSense is strictly prohibited.
 *
 * EXCEPT AS OTHERWISE PROVIDED IN A LICENSE AGREEMENT BETWEEN THE PARTIES, THE SOFTWARE IS
 * PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
 * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
 * EXCEPT AS OTHERWISE PROVIDED IN A LICENSE AGREEMENT BETWEEN THE PARTIES, IN NO EVENT SHALL
 * INVENSENSE BE LIABLE FOR ANY DIRECT, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
 * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THE SOFTWARE.
 * ________________________________________________________________________________________________________
 */

/** @defgroup SelfTest Self-test
 *  @brief    API to execute self-test procedures.
 *  @{
 */

/** @file Icm426xxSelfTest.h */

#ifndef _INV_ICM426XX_SELFTEST_H_
#define _INV_ICM426XX_SELFTEST_H_

#include "InvExport.h"

#ifdef __cplusplus
extern "C" {
#endif

/* forward declaration */
struct inv_icm426xx;

/** @brief Perform hardware self-test for Accel and Gyro
 *  @param[in] s       Pointer to device.
 *  @param[in] result  Containing ACCEL_SUCCESS<<1 | GYRO_SUCCESS so 3
 *  @return            0 on success, negative value on error.
 */
int inv_icm426xx_run_selftest(struct inv_icm426xx *s, int *result);

/** @brief Retrieve bias collected by self-test.
 *  @param[in] s         Pointer to device.
 *  @param[out] st_bias  Bias scaled by 2^16, accel is gee and gyro is dps.
 *                       The buffer will be filled as below.
 *                       Gyro LN mode X,Y,Z
 *                       Accel LN mode X,Y,Z
 *  @return              0 on success, negative value on error.
 */
int inv_icm426xx_get_st_bias(struct inv_icm426xx *s, int st_bias[6]);

/** @brief Apply bias.
 *  @param[in] s        Pointer to device.
 *  @param[in] st_bias  Bias scaled by 2^16, accel is gee and gyro is dps.
 *                      The buffer must be filled as below.
 *                      Gyro LN mode X,Y,Z
 *                      Accel LN mode X,Y,Z
 *  @return             0 on success, negative value on error.
 */
int inv_icm426xx_set_st_bias(struct inv_icm426xx *s, const int st_bias[6]);

#ifdef __cplusplus
}
#endif

#endif /* _INV_ICM426XX_SELFTEST_H_ */

/** @} */
